<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::ParticleDynamics&lt; ReturnType &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_particle_dynamics.html">ParticleDynamics</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_particle_dynamics-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::ParticleDynamics&lt; ReturnType &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>The base class for all particle dynamics This class contains the only two interface functions available for particle dynamics. An specific implementation should be realized.  
 <a href="class_s_p_h_1_1_particle_dynamics.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="base__particle__dynamics_8h_source.html">base_particle_dynamics.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_global_static_variables.html">SPH::GlobalStaticVariables</a>.</p>

<p>Inherited by <a class="el" href="class_s_p_h_1_1_part_dynamics_by_cell_reduce.html">SPH::PartDynamicsByCellReduce&lt; ReturnType, ReduceOperation &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle_reduce.html">SPH::PartDynamicsByParticleReduce&lt; ReturnType, ReduceOperation &gt;</a>, and <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html">SPH::ParticleDynamicsReduce&lt; ReturnType, ReduceOperation &gt;</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a79d1c47689c57d6f956032d4bd75cdc2"><td class="memItemLeft" align="right" valign="top"><a id="a79d1c47689c57d6f956032d4bd75cdc2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ParticleDynamics</b> (<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *sph_body)</td></tr>
<tr class="separator:a79d1c47689c57d6f956032d4bd75cdc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab84153bd29b90450a14c68750af60d1"><td class="memItemLeft" align="right" valign="top"><a id="aab84153bd29b90450a14c68750af60d1"></a>
<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getSPHBody</b> ()</td></tr>
<tr class="separator:aab84153bd29b90450a14c68750af60d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8547795a86452f89ae7a3a4dc30686b2"><td class="memItemLeft" align="right" valign="top">virtual ReturnType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_particle_dynamics.html#a8547795a86452f89ae7a3a4dc30686b2">exec</a> (Real dt=0.0)=0</td></tr>
<tr class="separator:a8547795a86452f89ae7a3a4dc30686b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39674d396c8ae2d7433b2ed912dc1a25"><td class="memItemLeft" align="right" valign="top"><a id="a39674d396c8ae2d7433b2ed912dc1a25"></a>
virtual ReturnType&#160;</td><td class="memItemRight" valign="bottom"><b>parallel_exec</b> (Real dt=0.0)=0</td></tr>
<tr class="separator:a39674d396c8ae2d7433b2ed912dc1a25"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a6c3ffa11bc0514cd9eb1537b79b4975c"><td class="memItemLeft" align="right" valign="top"><a id="a6c3ffa11bc0514cd9eb1537b79b4975c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setBodyUpdated</b> ()</td></tr>
<tr class="separator:a6c3ffa11bc0514cd9eb1537b79b4975c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab027ee6fb13881db2bc8277ef56d4b58"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_particle_dynamics.html#ab027ee6fb13881db2bc8277ef56d4b58">setupDynamics</a> (Real dt=0.0)</td></tr>
<tr class="separator:ab027ee6fb13881db2bc8277ef56d4b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a2c547f5f8f9cc2506a6a726fe59b270e"><td class="memItemLeft" align="right" valign="top"><a id="a2c547f5f8f9cc2506a6a726fe59b270e"></a>
<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>sph_body_</b></td></tr>
<tr class="separator:a2c547f5f8f9cc2506a6a726fe59b270e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5500b7cdde4aaf52d35109d51567ecc"><td class="memItemLeft" align="right" valign="top"><a id="ae5500b7cdde4aaf52d35109d51567ecc"></a>
<a class="el" href="class_s_p_h_1_1_particle_adaptation.html">ParticleAdaptation</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>particle_adaptation_</b></td></tr>
<tr class="separator:ae5500b7cdde4aaf52d35109d51567ecc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30723682b9301b81211d9f1c0aec4f5c"><td class="memItemLeft" align="right" valign="top"><a id="a30723682b9301b81211d9f1c0aec4f5c"></a>
<a class="el" href="class_s_p_h_1_1_base_particles.html">BaseParticles</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>base_particles_</b></td></tr>
<tr class="separator:a30723682b9301b81211d9f1c0aec4f5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_class_s_p_h_1_1_global_static_variables')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="class_s_p_h_1_1_global_static_variables.html">SPH::GlobalStaticVariables</a></td></tr>
<tr class="memitem:ade84c016ddfa66794108619277313c82 inherit pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td class="memItemLeft" align="right" valign="top">static Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_global_static_variables.html#ade84c016ddfa66794108619277313c82">physical_time_</a> = 0.0</td></tr>
<tr class="separator:ade84c016ddfa66794108619277313c82 inherit pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class ReturnType = void&gt;<br />
class SPH::ParticleDynamics&lt; ReturnType &gt;</h3>

<p>The base class for all particle dynamics This class contains the only two interface functions available for particle dynamics. An specific implementation should be realized. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8547795a86452f89ae7a3a4dc30686b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8547795a86452f89ae7a3a4dc30686b2">&#9670;&nbsp;</a></span>exec()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ReturnType  = void&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ReturnType <a class="el" href="class_s_p_h_1_1_particle_dynamics.html">SPH::ParticleDynamics</a>&lt; ReturnType &gt;::exec </td>
          <td>(</td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>dt</em> = <code>0.0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The only two functions can be called from outside One is for sequential execution, the other is for parallel. </p>

<p>Implemented in <a class="el" href="class_s_p_h_1_1_mirror_boundary_condition_in_axis_direction.html#ad264e578081cd52ac89d8bc60d768ebd">SPH::MirrorBoundaryConditionInAxisDirection</a>, <a class="el" href="class_s_p_h_1_1_mirror_boundary_condition_in_axis_direction_1_1_updating_ghost_states.html#ae7be0ee35b4ff7bacef49239635893b5">SPH::MirrorBoundaryConditionInAxisDirection::UpdatingGhostStates</a>, <a class="el" href="class_s_p_h_1_1_mirror_boundary_condition_in_axis_direction_1_1_mirror_bounding.html#aed5277f4bcae61f56331c75d4441d99e">SPH::MirrorBoundaryConditionInAxisDirection::MirrorBounding</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle_reduce.html#a90125c59f974aaaa643bc211d218b992">SPH::PartDynamicsByParticleReduce&lt; ReturnType, ReduceOperation &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle_reduce.html#a90125c59f974aaaa643bc211d218b992">SPH::PartDynamicsByParticleReduce&lt; SimTK::SpatialVec, ReduceSum&lt; SimTK::SpatialVec &gt; &gt;</a>, <a class="el" href="class_s_p_h_1_1relax__dynamics_1_1_relaxation_step_inner.html#a0b2a44814e5e453df6dd4b0c4ee6bf00">SPH::relax_dynamics::RelaxationStepInner</a>, <a class="el" href="class_s_p_h_1_1_interaction_dynamics_splitting.html#a6389a33a740f6adfe679fa5115af78d1">SPH::InteractionDynamicsSplitting</a>, <a class="el" href="class_s_p_h_1_1_relaxation_of_all_diffusion_species_r_k2.html#aa22ce7bc1d540b7e691544bd8cf556c0">SPH::RelaxationOfAllDiffusionSpeciesRK2&lt; BodyType, BaseParticlesType, BaseMaterialType, RungeKutta2Stages1stStageType, BodyRelationType &gt;</a>, <a class="el" href="class_s_p_h_1_1_relaxation_of_all_diffusion_species_r_k2.html#aa22ce7bc1d540b7e691544bd8cf556c0">SPH::RelaxationOfAllDiffusionSpeciesRK2&lt; SolidBody, SolidParticles, Solid, RelaxationOfAllDiffussionSpeciesInner&lt; SolidBody, SolidParticles, Solid &gt;, BaseInnerBodyRelation &gt;</a>, <a class="el" href="class_s_p_h_1_1solid__dynamics_1_1_clamp_constrain_solid_body_region.html#af4707ca660da697c962450bdf231398e">SPH::solid_dynamics::ClampConstrainSolidBodyRegion</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics1_level.html#ad26df033ea045dcc268756e821d588c7">SPH::ParticleDynamics1Level</a>, <a class="el" href="class_s_p_h_1_1_interaction_dynamics_with_update.html#aea7f57f16e7e9a34c7565cb353d6fc54">SPH::InteractionDynamicsWithUpdate</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_cell_reduce.html#a777096a05aab92a12e492621ed0fbd6c">SPH::PartDynamicsByCellReduce&lt; ReturnType, ReduceOperation &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_cell_reduce.html#a777096a05aab92a12e492621ed0fbd6c">SPH::PartDynamicsByCellReduce&lt; Real, ReduceMax &gt;</a>, <a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction_1_1_periodic_condition.html#a12be61c1af6f5af0fdb431da9861f633">SPH::PeriodicConditionInAxisDirection::PeriodicCondition</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_cell.html#a0ffe4851a64c6f099e91f00bcebb061a">SPH::PartDynamicsByCell</a>, <a class="el" href="class_s_p_h_1_1_interaction_dynamics.html#a477499ce3f12bda4231e88b4e0abe3bf">SPH::InteractionDynamics</a>, <a class="el" href="class_s_p_h_1_1_periodic_condition_in_axis_direction_1_1_periodic_bounding.html#a7f40dd23ff94e1bc52b46c200882118a">SPH::PeriodicConditionInAxisDirection::PeriodicBounding</a>, <a class="el" href="class_s_p_h_1_1_part_interaction_dynamics_by_particle1_level.html#a63351b1b83a00f961d0e8730d4207f52">SPH::PartInteractionDynamicsByParticle1Level</a>, <a class="el" href="class_s_p_h_1_1_part_interaction_dynamics_by_particle_with_update.html#ac5f215bf7dcbec83cb4eb636dd9465bf">SPH::PartInteractionDynamicsByParticleWithUpdate</a>, <a class="el" href="class_s_p_h_1_1_get_diffusion_time_step_size.html#abbafdb225bf35578cb3d8d891f54b1e9">SPH::GetDiffusionTimeStepSize&lt; BodyType, BaseParticlesType, BaseMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_get_diffusion_time_step_size.html#abbafdb225bf35578cb3d8d891f54b1e9">SPH::GetDiffusionTimeStepSize&lt; SolidBody, SolidParticles, Solid &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; ReturnType, ReduceOperation &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; Vecd, ReduceSum&lt; Vecd &gt; &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; Real, ReduceSum&lt; Real &gt; &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; VariableType, ReduceSum&lt; VariableType &gt; &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; Real, ReduceMin &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; Vecd, ReduceUpperBound &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; Real, ReduceMax &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; Vecd, ReduceLowerBound &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#ac99d4c39007ae77d09e51261ffc8528d">SPH::ParticleDynamicsReduce&lt; bool, ReduceOR &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_simple.html#a0d84f20b598c6da0894b837b94940bc3">SPH::ParticleDynamicsSimple</a>, and <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle.html#a9d95efb3814fe94d1cc59f3814ec7b5d">SPH::PartDynamicsByParticle</a>.</p>

</div>
</div>
<a id="ab027ee6fb13881db2bc8277ef56d4b58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab027ee6fb13881db2bc8277ef56d4b58">&#9670;&nbsp;</a></span>setupDynamics()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ReturnType  = void&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="class_s_p_h_1_1_particle_dynamics.html">SPH::ParticleDynamics</a>&lt; ReturnType &gt;::setupDynamics </td>
          <td>(</td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>dt</em> = <code>0.0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>the function for set global parameters for the particle dynamics </p>

<p>Reimplemented in <a class="el" href="class_s_p_h_1_1solid__dynamics_1_1_constrain_solid_body_part_by_sim_body.html#a047c4e59137413e06ab1db890768254f">SPH::solid_dynamics::ConstrainSolidBodyPartBySimBody</a>, <a class="el" href="class_s_p_h_1_1_mirror_boundary_condition_in_axis_direction_1_1_creating_ghost_particles.html#a70febe9d33391cd0073212d9aec1a42d">SPH::MirrorBoundaryConditionInAxisDirection::CreatingGhostParticles</a>, <a class="el" href="class_s_p_h_1_1solid__dynamics_1_1_constrain_solid_body_mass_center.html#a4f69cc8c5d30fdedf2d0b69f99444246">SPH::solid_dynamics::ConstrainSolidBodyMassCenter</a>, <a class="el" href="class_s_p_h_1_1fluid__dynamics_1_1_transport_velocity_correction_inner.html#a6065ba4d01ed00a14f1490fd35259425">SPH::fluid_dynamics::TransportVelocityCorrectionInner</a>, <a class="el" href="class_s_p_h_1_1_combined_interaction_dynamics.html#ae8882d0cb0bfbf66fc4b08546ff7dfca">SPH::CombinedInteractionDynamics</a>, and <a class="el" href="class_s_p_h_1_1_initialize_a_time_step.html#ad2cbb32573266c1098331e0b755a5866">SPH::InitializeATimeStep</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>SPHINXsys/src/shared/particle_dynamics/<a class="el" href="base__particle__dynamics_8h_source.html">base_particle_dynamics.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
